home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 1998 November / IRIX 6.5.2 Base Documentation November 1998.img / usr / share / catman / u_man / cat1 / proclaim.z / proclaim
Text File  |  1998-10-30  |  15KB  |  331 lines
  1.  
  2.  
  3.  
  4. pppprrrrooooccccllllaaaaiiiimmmm((((1111MMMM))))                                                      pppprrrrooooccccllllaaaaiiiimmmm((((1111MMMM))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      proclaim - client for Dynamic Host Configuration Protocol (DHCP)
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      ////uuuussssrrrr////eeeettttcccc////pppprrrrooooccccllllaaaaiiiimmmm [ ----BBBB ] [ ----bbbb _l_e_a_s_e__t_i_m_e ] [ ----dddd ----ssss _s_e_r_v_e_r__a_d_d_r ] [ ----EEEE ]
  13.          [ ----eeee _2_n_d__i_n_t_e_r_f_a_c_e ] [ ----IIII ] [ ----iiii ] [ ----llll _l_e_a_s_e__t_i_m_e ] [ ----pppp ]
  14.          [ ----rrrr _l_e_a_s_e__t_i_m_e ----ssss _s_e_r_v_e_r__a_d_d_r ] [ ----tttt _r_e_p_e_a_t ] [ ----xxxx _m_a_x__t_i_m_e_o_u_t ]
  15.          [ ----wwww ----hhhh _h_o_s_t__n_a_m_e ----aaaa _i_p__a_d_d_r ]
  16.  
  17. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  18.      _P_r_o_c_l_a_i_m is a client that communicates with a DHCP server to obtain
  19.      configuration parameters, including at least an IP address.  The format
  20.      of DHCP messages is based on the format of _b_o_o_t_p messages, described in
  21.      RFC 951.  A detailed protocol specification of DHCP is in RFC 1541,
  22.      available from the Network Information Center.
  23.  
  24.      The DHCP protocol uses UDP/IP as its transport mechanism.  The DHCP
  25.      server receives service requests at the UDP port indicated in the _b_o_o_t_p
  26.      service description contained in the file /_e_t_c/_s_e_r_v_i_c_e_s; see _s_e_r_v_i_c_e_s(4).
  27.  
  28.      _P_r_o_c_l_a_i_m can be used to setup and configure new systems automatically,
  29.      and to move systems from one net to another without administrative
  30.      intervention.  It can also be used to automatically verify current
  31.      configurations at reboot.  Only the superuser can employ _p_r_o_c_l_a_i_m.  If
  32.      the primary network interface is changed, _p_r_o_c_l_a_i_m updates the _n_e_t_a_d_d_r
  33.      variable in the NVRAM.
  34.  
  35.      In the absence of the DHCPoptionsToGet keyword, _p_r_o_c_l_a_i_m requests the
  36.      following configuration parameters from an available DHCP server:
  37.  
  38.           an IP address
  39.           the lease duration (3 year default)
  40.           the subnet mask
  41.           hostname (users may be allowed to choose their own)
  42.           NIS domainname if the NIS option is installed.
  43.           IP address of the DHCP server; see _d_h_c_p__b_o_o_t_p(1M).
  44.  
  45.      The DHCP server is started by _i_n_e_t_d(1M), as configured in the _i_n_e_t_d._c_o_n_f
  46.      file.  The basic operation of the DHCP protocol is a series of packet
  47.      exchanges as follows:
  48.  
  49.      1)  The client machine broadcasts a DHCPDISCOVER packet to the DHCP
  50.          server's UDP port, using a UDP broadcast equivalent.  The request
  51.          packet includes the requester's network hardware address, and a list
  52.          of desired configuration options as described above.
  53.  
  54.      2)  All the DHCP servers on the same network as the client machine
  55.          receive the client's request as do the _b_o_o_t_p relay agents, which
  56.          forward the request to other subnets.
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. pppprrrrooooccccllllaaaaiiiimmmm((((1111MMMM))))                                                      pppprrrrooooccccllllaaaaiiiimmmm((((1111MMMM))))
  71.  
  72.  
  73.  
  74.      3)  The server looks up the requester in its configuration files to
  75.          determine if it is configured to serve clients from the requesting
  76.          subnet.  The server now looks in the _p_r_o_p_e_l database or the
  77.          /_e_t_c/_e_t_h_e_r_s file (see _e_t_h_e_r_s(4)) for an entry with the client's
  78.          network hardware address.  If an entry is found, the server checks
  79.          the hostname of that entry against the _p_r_o_p_e_l database or the
  80.          /_e_t_c/_h_o_s_t_s file (see _h_o_s_t_s(4)) to complete the network hardware
  81.          address to Internet address mapping.
  82.  
  83.          If no entry is found, the server generates an appropriate IP address
  84.          and hostname using its configuration files; see _d_h_c_p__b_o_o_t_p(1M).
  85.  
  86.      4)  The server now returns a response in the form of a DHCPOFFER packet,
  87.          which also includes other configuration information requested by the
  88.          client.
  89.  
  90.      5)  The client accepts the first valid offer from a server and broadcasts
  91.          back a DHCPREQUEST message, which includes all the configuration
  92.          options from the DHCPDISCOVER message plus the address of the
  93.          selected server.
  94.  
  95.      6)  The selected server makes a permanent mapping for the client's
  96.          hostname, IP address, and hardware address, and responds with a
  97.          DHCPACK message.
  98.  
  99.      7)  On receiving the DHCPACK message from the server, the client writes
  100.          the configuration information into the appropriate configuration
  101.          files and then executes the networking initialization scripts.
  102.  
  103.      If the server is configured in a manner where clients from specific
  104.      subnets are allowed to choose their own hostname, then at the receipt of
  105.      the DHCPOFFER message the client requests user input to either accept the
  106.      offered hostname or specify a different one.  This dialog between the
  107.      server and client continues until a valid and unique mutually acceptable
  108.      name is selected.  Alternately, the ----wwww option can be used to request a
  109.      hostname and/or IP address non-interactively.  The client will print an
  110.      error and exit if the requested hostname or address is invalid.
  111.  
  112.      _P_r_o_c_l_a_i_m sleeps after obtaining a new lease or after verifying an
  113.      existing lease, until it is time to renew the lease.  The client wakes up
  114.      at times specified by the DHCP protocol and attempts to renew the lease
  115.      until it succeeds or the current lease expires.  If the client is unable
  116.      to renew the lease then it can shutoff nnnneeeettttwwwwoooorrrrkkkk access depending on the
  117.      use of the ----EEEE option.
  118.  
  119.  
  120. OOOOPPPPTTTTIIIIOOOONNNNSSSS
  121.      The ----BBBB option broadcasts a BOOTP packet to a BOOTP 1533 server.  This is
  122.      useful when you just want to obtain the other configuration data, and the
  123.      IP address is not otherwise known to the BOOTP or DHCP server.  The data
  124.      is placed in the file ////vvvvaaaarrrr////aaaaddddmmmm////pppprrrrooooccccllllaaaaiiiimmmm....ddddaaaattttaaaa.  _p_r_o_c_l_a_i_m does not change
  125.      any networking state with this option.
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. pppprrrrooooccccllllaaaaiiiimmmm((((1111MMMM))))                                                      pppprrrrooooccccllllaaaaiiiimmmm((((1111MMMM))))
  137.  
  138.  
  139.  
  140.      The ----bbbb _l_e_a_s_e__t_i_m_e option is used to manually rebind the lease; a
  141.      _l_e_a_s_e__t_i_m_e in seconds must be specified.
  142.  
  143.      The ----dddd option allows the client to surrender its address lease and
  144.      shutdown all networking.  This option can only be used in conjunction
  145.      with the ----ssss _s_e_r_v_e_r__a_d_d_r_e_s_s option to specify the Proclaim server address.
  146.      This usually is the server from where the original address lease was
  147.      obtained.  If there is a client running on the host use the
  148.      ////eeeettttcccc////iiiinnnniiiitttt....dddd////rrrruuuunnnn----pppprrrrooooccccllllaaaaiiiimmmm ssssuuuurrrrrrrreeeennnnddddeeeerrrr command to surrender the lease.
  149.  
  150.      The ----EEEE option is used to specify that network access should be shut off
  151.      if the client is unable to renew the lease and the lease expires.  The
  152.      default behavior does not shut off network access if the lease expires.
  153.  
  154.      The ----eeee _2_n_d__i_n_t_e_r_f_a_c_e option is used to specify the device for a second
  155.      network interface.
  156.  
  157.      The ----IIII option is used to send a DHCPINFORM packet to a DHCP server.  This
  158.      is useful when an IP address was assigned to the host using some other
  159.      means and it is required to obtain only other configuration parameters.
  160.  
  161.      The ----iiii option is used where the client is seeking to verify a previously
  162.      allocated, cached configuration.  If the client receives a DHCPNAK
  163.      response to this message, it means that either the 'requested IP address'
  164.      parameter is incorrect or the client is on the wrong network.  The client
  165.      automatically requests a new address and lease and proceeds to install
  166.      the new configuration.  If there is no response, it means the server(s)
  167.      has no record of this client.  These messages are logged using the system
  168.      logging daemon _s_y_s_l_o_g_d(1M). If a client is running on the host use the
  169.      ////eeeettttcccc////iiiinnnniiiitttt....dddd////rrrruuuunnnn----pppprrrrooooccccllllaaaaiiiimmmm vvvveeeerrrriiiiffffyyyy command to verify the lease.
  170.  
  171.      The ----llll _l_e_a_s_e__t_i_m_e option is used to request a different address lease
  172.      duration than the default of 3 years.  The lease time needs to be
  173.      specified in number of seconds.
  174.  
  175.      The ----pppp option is used to print the status of the current lease and other
  176.      configuration parameters.  This status is obtained from the
  177.      /_v_a_r/_a_d_m/_p_r_o_c_l_a_i_m._l_e_a_s_e__i_n_f_o file created at the time the lease was
  178.      obtained.
  179.  
  180.      The ----rrrr _l_e_a_s_e__t_i_m_e ----ssss _s_e_r_v_e_r__a_d_d_r option is used to manually renew the
  181.      lease; a _l_e_a_s_e__t_i_m_e in seconds must be specified. The _s_e_r_v_e_r__a_d_d_r
  182.      specifies the server with which to renew the lease.  The server address
  183.      may be obtained by using the -p option of _p_r_o_c_l_a_i_m.
  184.  
  185.      The ----tttt _i_n_v_o_c_a_t_i_o_n_s option is used to specify the number of invocations of
  186.      the client using the _r_u_n-_p_r_o_c_l_a_i_m(1M) script, after which the
  187.      _a_u_t_o_c_o_n_f_i_g__i_p_a_d_d_r_e_s_s flag is set to off (see _c_h_k_c_o_n_f_i_g(1M)).  When this
  188.      option is not specified the client may be run up to a default 2 (or as
  189.      specified in the /_e_t_c/_c_o_n_f_i_g/_p_r_o_c_l_a_i_m._o_p_t_i_o_n_s file) number of times using
  190.      the script after which the flag is set to off.  Use of the script to run
  191.      the client requires the flag to be set to on.
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. pppprrrrooooccccllllaaaaiiiimmmm((((1111MMMM))))                                                      pppprrrrooooccccllllaaaaiiiimmmm((((1111MMMM))))
  203.  
  204.  
  205.  
  206.      The ----xxxx _m_a_x__t_i_m_e_o_u_t option is used to specify a maximum timeout (time to
  207.      wait for a server to reply) in seconds.  The current default is set to 6
  208.      seconds.
  209.  
  210.      The ----wwww ----hhhh _h_o_s_t__n_a_m_e ----aaaa _i_p__a_d_d_r option is used to choose a hostname and IP
  211.      address without the user being prompted by the client. If no _h_o_s_t__n_a_m_e or
  212.      _i_p__a_d_d_r is specified, the the hostname and IP address offered by the
  213.      server will be used.  If only the _h_o_s_t__n_a_m_e is specified, the server will
  214.      choose an appropriate IP address. This option was added to make it
  215.      possible to run _p_r_o_c_l_a_i_m from a CGI script.
  216.  
  217.  
  218.    OOOOppppttttiiiioooonnnnssss FFFFiiiilllleeee
  219.      Options may also be specified in the /_e_t_c/_c_o_n_f_i_g/_p_r_o_c_l_a_i_m._o_p_t_i_o_n_s file.
  220.      Options specified on the command line supersede those specified in this
  221.      file.  Lines beginning with a '#' are treated as comments.  The option
  222.      keywords in this file must be followed immediately by a colon, then by
  223.      any number of tabs or spaces, and finally by the value of the option.
  224.  
  225.      Here are the supported keywords:
  226.           Invocations       equivalent to ----tttt option
  227.           MaxTimeout        equivalent to ----xxxx option
  228.           ServerAddress     equivalent to ----ssss option
  229.           ShutdownOnExpiry  equivalent to ----EEEE option
  230.           Lease             equivalent to ----llll option
  231.           DHCPoptionsToGet  additional options to request from DHCP server
  232.  
  233.      Additional options which are not keywords specify whether the _r_u_n-
  234.      _p_r_o_c_l_a_i_m script should try to obtain configuration parameters for all the
  235.      network interfaces on the system. If none of these options are present
  236.      then the _p_r_o_c_l_a_i_m client is invoked for the primary interface only.
  237.  
  238.      The options are:
  239.           PPPPrrrriiiimmmmaaaarrrryyyy oooonnnn||||ooooffffffff
  240.           IIIInnnntttteeeerrrrffffaaaacccceeee         interface  oooonnnn||||ooooffffffff
  241.  
  242.      The presence of an oooonnnn invokes the _p_r_o_c_l_a_i_m client and ooooffffffff does not invoke
  243.      it for the specified interface when the _r_u_n-_p_r_o_c_l_a_i_m script is executed
  244.      with a ssssttttaaaarrrrtttt argument. The value of interface is the name, for example,
  245.      ec1, xpi1, etc.
  246.  
  247. FFFFIIIILLLLEEEESSSS
  248.      /etc/hosts
  249.      /etc/ethers
  250.      /etc/config/ifconfig-1.options
  251.      /.rhosts
  252.      /etc/sys_id
  253.      /usr/etc/yp/ypdomain
  254.      /etc/init.d/network
  255.      /var/adm/proclaim.lease_info
  256.      /var/adm/proclaim.data
  257.      /etc/config/proclaim.options
  258.  
  259.  
  260.  
  261.                                                                         PPPPaaaaggggeeee 4444
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268. pppprrrrooooccccllllaaaaiiiimmmm((((1111MMMM))))                                                      pppprrrrooooccccllllaaaaiiiimmmm((((1111MMMM))))
  269.  
  270.  
  271.  
  272.      /etc/init.d/run-proclaim
  273.  
  274.  
  275. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  276.      bootp(1M), dhcp_bootp(1M), inetd(1M), propel(1M), run-proclaim(1M),
  277.      syslogd(1M), ethers(4), hosts(4)
  278.  
  279.  
  280.  
  281.  
  282.  
  283.  
  284.  
  285.  
  286.  
  287.  
  288.  
  289.  
  290.  
  291.  
  292.  
  293.  
  294.  
  295.  
  296.  
  297.  
  298.  
  299.  
  300.  
  301.  
  302.  
  303.  
  304.  
  305.  
  306.  
  307.  
  308.  
  309.  
  310.  
  311.  
  312.  
  313.  
  314.  
  315.  
  316.  
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.  
  325.  
  326.  
  327.                                                                         PPPPaaaaggggeeee 5555
  328.  
  329.  
  330.  
  331.